---
title: Report an Issue 📢
sidebarTitle: Report an Issue
---

If you want to report a bug, request a feature, suggest docs improvements, or propose a new integration, you can do that on the [MindsDB GitHub issues page](https://github.com/mindsdb/mindsdb/issues).

But before reporting a new issue, please make sure that it is not already there.

## How to Create an Issue

Here is how to get started when you want to create an issue in the MindsDB repository.

Go to [our GitHub issues page](https://github.com/mindsdb/mindsdb/issues)
and click on the _New issue_ button.

<p align="center">
  <img src="/assets/report_issues/1_reporting_new_issue.png" />
</p>

Now you see the available issue types.

<p align="center">
  <img src="/assets/report_issues/1_issue_types.png" />
</p>

Let's go through all of them one by one.

### Report a Bug 🐞

Here, we choose `Report a bug` and click on the _Get started_ button.

<p align="center">
  <img src="/assets/report_issues/2_bug_report.png" />
</p>

Now, it's time to fill up the form.

1. It is vital to add a meaningful issue title.

   <p align="center">
     <img src="/assets/report_issues/2_bug_report_form_1.png" />
   </p>

2. Here, you describe the current behavior. Please note that this field is mandatory. Below you can attach any videos or screenshots of the current behavior.

   <p align="center">
     <img src="/assets/report_issues/2_bug_report_form_2.png" />
   </p>

3. If you know what the expected behavior should be, you can add it here.

   <p align="center">
     <img src="/assets/report_issues/2_bug_report_form_3.png" />
   </p>

4. It is helpful for us if you add the steps you followed that led you to the
   error.

   <p align="center">
     <img src="/assets/report_issues/2_bug_report_form_4.png" />
   </p>

5. Any links, references, logs, screenshots, etc., are welcome!

   <p align="center">
     <img src="/assets/report_issues/2_bug_report_form_5.png" />
   </p>

<Info>
  Remember, all contributions to our repository should follow the [contributing
  guidelines](https://github.com/mindsdb/mindsdb/blob/staging/CONTRIBUTING.md)
  and [code of
  conduct](https://github.com/mindsdb/mindsdb/blob/staging/CODE_OF_CONDUCT.md).
</Info>

Thank you for reporting a bug! It helps us improve MindsDB for you and future
users.

### Request a Feature 🚀

Here, we choose `Request a feature` and click on the _Get started_ button.

<p align="center">
  <img src="/assets/report_issues/3_feature_request.png" />
</p>

Now, it's time to fill up the form.

1. It is vital to add a meaningful issue title.

   <p align="center">
     <img src="/assets/report_issues/3_feature_request_form_1.png" />
   </p>

2. Here, you describe the feature request along with the motivation for the proposed feature. Please note that this field is mandatory. Below you can attach any videos or screenshots.

   <p align="center">
     <img src="/assets/report_issues/3_feature_request_form_2.png" />
   </p>

3. If you know how the solution should look, you can add it here.

   <p align="center">
     <img src="/assets/report_issues/3_feature_request_form_3.png" />
   </p>

4. Any links, references, logs, screenshots, etc., are welcome!

   <p align="center">
     <img src="/assets/report_issues/3_feature_request_form_4.png" />
   </p>

<Info>
  Remember, all contributions to our repository should follow the [contributing
  guidelines](https://github.com/mindsdb/mindsdb/blob/staging/CONTRIBUTING.md)
  and [code of
  conduct](https://github.com/mindsdb/mindsdb/blob/staging/CODE_OF_CONDUCT.md).
</Info>

Thank you for submitting a feature request! It helps us improve MindsDB for you
and future users.

### Improve our Docs ✍️

Here, we choose `Improve our docs` and click on the _Get started_ button.

<p align="center">
  <img src="/assets/report_issues/4_improve_docs.png" />
</p>

Now, it's time to fill up the form.

1. It is vital to add a meaningful issue title.

   <p align="center">
     <img src="/assets/report_issues/4_improve_docs_form_1.png" />
   </p>

2. Here, you describe what should be added or improved. Please note that this field is mandatory. Below you can attach any videos or screenshots.

   <p align="center">
     <img src="/assets/report_issues/4_improve_docs_form_2.png" />
   </p>

3. Any links, references, logs, screenshots, etc., are welcome!

   <p align="center">
     <img src="/assets/report_issues/4_improve_docs_form_3.png" />
   </p>

<Info>
  Remember, all contributions to our repository should follow the [contributing
  guidelines](https://github.com/mindsdb/mindsdb/blob/staging/CONTRIBUTING.md)
  and [code of
  conduct](https://github.com/mindsdb/mindsdb/blob/staging/CODE_OF_CONDUCT.md).
</Info>

Thank you for suggesting docs enhancements! It helps us improve MindsDB for you
and future users.

### Propose a New Integration 🧑‍🔧

Here is how to get started when you want to propose a new integration. Please note it can be a new database integrations or a new machine learning framework.

We choose `Propose a new integration` and click on the _Get started_ button.

<p align="center">
  <img src="/assets/report_issues/5_new_integration.png" />
</p>

Now, it's time to fill up the form.

1. It is vital to add a meaningful issue title.

   <p align="center">
     <img src="/assets/report_issues/5_new_integration_form_1.png" />
   </p>

2. Please make sure that this integration is not already implemented.

   <p align="center">
     <img src="/assets/report_issues/5_new_integration_form_2.png" />
   </p>

3. Here, you describe the use case(s) solved by this integration.

   <p align="center">
     <img src="/assets/report_issues/5_new_integration_form_3.png" />
   </p>

4. Please provide a motivation for your integration proposal.

   <p align="center">
     <img src="/assets/report_issues/5_new_integration_form_4.png" />
   </p>

5. Get creative and describe the implementation! You can use code, text, diagrams, etc.

   <p align="center">
     <img src="/assets/report_issues/5_new_integration_form_5.png" />
   </p>

6. Any links, references, logs, screenshots, etc., are welcome!

   <p align="center">
     <img src="/assets/report_issues/5_new_integration_form_6.png" />
   </p>

<Info>
  Remember, all contributions to our repository should follow the [contributing
  guidelines](https://github.com/mindsdb/mindsdb/blob/staging/CONTRIBUTING.md)
  and [code of
  conduct](https://github.com/mindsdb/mindsdb/blob/staging/CODE_OF_CONDUCT.md).
</Info>

Thank you for proposing a new integration! It helps us improve MindsDB for you
and future users.

### Report a Security Vulnerability

Here is how to get started when you want to report a security vulnerability. Please note that such issues are visible only to repository maintainers. Also, you will be credited if the advisory is published.

We choose `Report a security vulnerability` and click on the _Get started_ button.

<p align="center">
  <img src="/assets/report_issues/6_security_vulnerability.png" />
</p>

Now, it's time to fill up the form.

1. It is vital to add a meaningful issue title.

   <p align="center">
     <img src="/assets/report_issues/6_security_vulnerability_form_1.png" />
   </p>

2. Please follow the instructions to provide the best description.

   <p align="center">
     <img src="/assets/report_issues/6_security_vulnerability_form_2.png" />
   </p>

3. Here, you can choose one or more affected products along with the versions.

   <p align="center">
     <img src="/assets/report_issues/6_security_vulnerability_form_3.png" />
   </p>

4. Please assign the severity of the issue. The _Calculator_ feature can help you assess the severity.

   <p align="center">
     <img src="/assets/report_issues/6_security_vulnerability_form_4.png" />
   </p>

5. Here, you can assign one or more common weakness enumerators (CWE).

   <p align="center">
     <img src="/assets/report_issues/6_security_vulnerability_form_5.png" />
   </p>

<Info>
  Remember, all contributions to our repository should follow the [contributing
  guidelines](https://github.com/mindsdb/mindsdb/blob/staging/CONTRIBUTING.md)
  and [code of
  conduct](https://github.com/mindsdb/mindsdb/blob/staging/CODE_OF_CONDUCT.md).
</Info>

Thank you for reporting a security vulnerability! It helps us improve MindsDB for you
and future users.

## Issue Review

- Issues are reviewed regularly, usually daily.
- Depending on the issue type, it will be labeled as `Bug` or `enhancement`.
- Please make sure you respond to our feedback/questions regarding your issue.
